/*
 * Copyright 2011-2017 JacobLee007
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.honeybees.intellij.javadocs.model;

import java.util.List;
import java.util.Map;

import com.honeybees.intellij.javadocs.util.JavaDocUtils;
import org.jetbrains.annotations.NotNull;

/**
 * The type Java doc.
 *
 * @author Sergey Timofiychuk
 */
public class JavaDoc {

    private List<String> description;
    private Map<String, List<JavaDocTag>> tags;

    /**
     * Instantiates a new Java doc.
     *
     * @param description the Description
     * @param tags        the Tags
     */
    public JavaDoc(@NotNull List<String> description, @NotNull Map<String, List<JavaDocTag>> tags) {
        this.description = description;
        this.tags = tags;
    }

    /**
     * Gets the description.
     *
     * @return the Description
     */
    @NotNull
    public List<String> getDescription() {
        return description;
    }

    /**
     * Gets the tags.
     *
     * @return the Tags
     */
    @NotNull
    public Map<String, List<JavaDocTag>> getTags() {
        return tags;
    }

    /**
     * To java doc.
     *
     * @return the String
     */
    @NotNull
    public String toJavaDoc() {
        return JavaDocUtils.convertJavaDoc(this);
    }

}
